Skip to content

documentation: updated README and added troubleshooting.md - #1499

Open
SuganyaAK wants to merge 2 commits into
IntersectMBO:masterfrom
SuganyaAK:docs/readme
Open

SuganyaAK wants to merge 2 commits into
IntersectMBO:masterfrom
SuganyaAK:docs/readme

Conversation

@SuganyaAK

Copy link
Copy Markdown
Contributor

Context

While setting up the project locally, I noticed:

The README does not provide a convenient link to installation resources.
There is no centralized place for common setup issues.

To improve the first-time setup experience, this PR:

adds relevant installation links to the README
proposes a troubleshooting.md document to capture common issues and solutions
added discord channel
closed #1336 and reopened this PR

How to trust this PR

Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff
  • Changelog fragment added in .changes/

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant